Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

RwTxn + RoTxn documentation improvement. #174

Merged
merged 1 commit into from
Jul 10, 2023
Merged

RwTxn + RoTxn documentation improvement. #174

merged 1 commit into from
Jul 10, 2023

Conversation

darnuria
Copy link
Contributor

Hello!

Following #150, I feel like it was a good idea to document the possibles errors raisable by: http://www.lmdb.tech/doc/group__mdb.html#gad7ea55da06b77513609efebd44b26920

I didn't included ENOMEM since there is no variant yet maybe it's an other whole story.

@Kerollmops Kerollmops added this to the v0.20.0 milestone Jun 30, 2023
@darnuria darnuria changed the title Env::read_txn document possibles errors. RwTxn + RoTxn documentation improvement. Jul 9, 2023
Kerollmops
Kerollmops requested changes Jul 10, 2023
View reviewed changes
Copy link
Member

@Kerollmops Kerollmops left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you for this PR 🏂

heed/src/env.rs Outdated Show resolved Hide resolved
heed/src/env.rs Outdated Show resolved Hide resolved
heed/src/txn.rs Outdated Show resolved Hide resolved
heed/src/txn.rs Outdated Show resolved Hide resolved
Kerollmops
Kerollmops requested changes Jul 10, 2023
View reviewed changes
Copy link
Member

@Kerollmops Kerollmops left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Once the other documentation PR lands. Could you please rebase this one on main?

@darnuria
Copy link
Contributor Author

Once the other documentation PR lands. Could you please rebase this one on main?

Sure will squash + add co-author-by since you corrected a lot of typo !

@darnuria
Copy link
Contributor Author

darnuria commented Jul 10, 2023 •
edited
Loading

Oh forgot the osx semaphore limitation doing a last minute push.

src: #135 (comment)

Done

@Kerollmops @darnuria
Document Transactions possibles errors, locking and lmdb limitation.
a1faa2c 
Should Fix meilisearch#164

* Document error according to mdb_txn_begin documentation.
* Document what kind of locks lmdb do arround transactions
* Document limitation by design of transactions
* Document OSX limitation related to semaphores

Thanks to Kerollmops for the typo spotted in review.

Co-authored-by: Clément Renault <[email protected]>
@Kerollmops Kerollmops added the documentation Improvements or additions to documentation label Jul 10, 2023
@Kerollmops
Copy link
Member

Thank you very much for the documentation ❤️

@Kerollmops Kerollmops merged commit ef11704 into meilisearch:main Jul 10, 2023
@darnuria darnuria deleted the doc/read_txn branch July 12, 2023 09:13
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@Kerollmops Kerollmops Kerollmops approved these changes

Assignees
No one assigned
Labels
documentation Improvements or additions to documentation
Projects
None yet
Milestone
v0.20.0
Development

Successfully merging this pull request may close these issues.
2 participants
@darnuria @Kerollmops